home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / dev / misc / FlexRev_0_55.lha / FlexRev / FlexRev.doc < prev    next >
Text File  |  1995-07-26  |  4KB  |  154 lines
  1. Documentation for FlexRev 0.55 by Daniel Kahlin <tlr@stacken.kth.se>
  2. -----------------------------------------------------------------------------
  3.  
  4. Distribution:
  5.  
  6.   FlexRev is FREEWARE (Freely-Distributable), but copyrighted by me. (NOT PD) 
  7. None of the included files may be modified and/or removed.  Permission is
  8. given to freely distribute this program provided you include all files from
  9. the original archive, and no fee is charged in excess of reasonable media
  10. and mailing costs.  The program may not be used for commercial purposes
  11. without written permission from the author.
  12.  
  13.  
  14. Disclaimer:
  15.  
  16.   I cannot in any way be held responsible for anything this program does.
  17. You are using it entirely at your own risk.  Every effort has been made to
  18. keep this program bug free.  But, IF for example a bug exists that blows up
  19. your entire computer, don't blame me.
  20.  
  21. -----------------------------------------------------------------------------
  22.  
  23. General:
  24.   FlexRev is designed to be flexible.  It should be possible to use it with
  25. almost any programming language.
  26.  
  27.  
  28. Documentation:
  29.  
  30. TEMPLATE: FlexRev REVFILE/A,TARGET,PROTO,IR=INCREVISION/S,IV=INCVERSION/S,
  31.                   DEBUG/S
  32.  
  33.     REVFILE/A      The filename of the REVISION file.
  34.     TARGET         name of file to be produced (can be omitted)
  35.     PROTO          name of the prototype (can be omitted)
  36.     IR/S           Increase the revision number
  37.     IV/S           Increase the version number
  38.     DEBUG/S        debugging info. (i.e will confuse you)
  39.  
  40.  
  41. The revfile:
  42. ------------
  43.   Two keywords MUST be present: VERSION and REVISION.  You probably want to
  44. include PROTO and TARGET, because then you can omit this from the command
  45. line.  All other keywords will just be defined, but no processed.
  46.  
  47.  
  48. The prototype:
  49. --------------
  50.   This file is a prototype of the output to be produced.  It is scanned for
  51. ${<keyword>} which is then replaced with the contents of this keyword.
  52. To get the character '$' you must double it. ('$$' becomes '$' in the output)
  53. The following keywords are defined by FlexRev:
  54.  
  55.   VERSION   - <versionnumber>
  56.   VER       - <versionnumber>
  57.   REVISION  - <revisionnumber>
  58.   REV       - <revisionnumber>
  59.   VERREV    - <version>.<revision>
  60.   DATE      - <d.m.yy>
  61.   TIME      - <hh:mm:ss>
  62.  
  63. You can also use the form ${n<keyword>}.  This will produce exactly n chars.
  64. If <keyword> contains less than n chars it will be padded by spaces and if
  65. <keyword> contains more than n chars it will be truncated.  'n' can several
  66. digits if necessary.
  67.  
  68.  
  69.  
  70.  
  71.  
  72. EXAMPLE Revfile
  73. --------------------
  74.  
  75. PROTO=revproto.h
  76. TARGET=Main_rev.h
  77. VERSION=0
  78. REVISION=53
  79. NAME=FlexRev
  80. LOWERNAME=flexrev
  81.  
  82. --------------------
  83.  
  84.  
  85. EXAMPLE protofile
  86. ----------------------------------------------
  87.  
  88. #define COMPILE_VERSION ${VERSION}
  89. #define COMPILE_REVISION ${REVISION}
  90. #define COMPILE_DATE "(${DATE})"
  91. #define COMPILE_TIME "${TIME}"
  92. #define PROGRAM_NAME "${NAME}"
  93. #define PROGRAM_SHORTNAME "${LOWERNAME}"
  94. #define PROGRAM_VER "${VERSION}.${REVISION}"
  95.  
  96. ----------------------------------------------
  97.  
  98.  
  99. The above will produce THIS:
  100. ----------------------------------------------
  101.  
  102. #define COMPILE_VERSION 0
  103. #define COMPILE_REVISION 53
  104. #define COMPILE_DATE "(13.7.95)"
  105. #define COMPILE_TIME "22:17:23"
  106. #define PROGRAM_NAME "FlexRev"
  107. #define PROGRAM_SHORTNAME "flexrev"
  108. #define PROGRAM_VER "0.53"
  109.  
  110. ----------------------------------------------
  111.  
  112.  
  113.  
  114. System requirements:
  115.  
  116.   FlexRev should run on any system setup running OS2.04 or higher, although
  117. it has only been tested on an A3000/25 running OS3.1.  If you find bugs or
  118. have suggestions about how to make the program better please send a bugreport
  119. and/or a list of suggestions to the address at the end of this text.
  120.  
  121. -----------------------------------------------------------------------------
  122.  
  123. History:
  124.  
  125. 0.55 (26.7.95) tlr
  126.   - Fixed minor bugs. Added prototypes.
  127.  
  128. 0.54 (13.7.95) tlr
  129.   - First working version. Is ok.
  130.  
  131.  
  132. Todo:
  133.  
  134. - more special expressions like ${m<keyword>}
  135. - better error reporting
  136.  
  137. -----------------------------------------------------------------------------
  138.  
  139. Author:
  140.  
  141.   Daniel Kahlin is a student at the Royal Institute of Technology (Stockholm)
  142. He is deeply involved with computers and electronics.
  143.  
  144.    InterNet:  <tlr@stacken.kth.se>
  145.  
  146.   SnailMail:  Daniel Kahlin
  147.               Vanadisvägen 6, 2tr
  148.               s-113 46 Stockholm
  149.               Sweden
  150.  
  151.       Phone:  08-34 84 73 (+468348473)
  152.  
  153. -----------------------------------------------------------------------------
  154.